opto8.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2026 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef OPTO8_H
#define OPTO8_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"




#define OPTO8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.out1 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.out2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_INT )
 // opto8_map // opto8

typedef struct
{
    digital_out_t out1;         
    digital_out_t out2;         
 
    digital_in_t in1;           
    digital_in_t in2;           
 
} opto8_t;

typedef struct
{
    pin_name_t in1;             
    pin_name_t out1;            
    pin_name_t out2;            
    pin_name_t in2;             
 
} opto8_cfg_t;

typedef enum
{
    OPTO8_OK = 0,
    OPTO8_ERROR = -1
 
} opto8_return_value_t;


void opto8_cfg_setup ( opto8_cfg_t *cfg );

err_t opto8_init ( opto8_t *ctx, opto8_cfg_t *cfg );

void opto8_set_out1 ( opto8_t *ctx );

void opto8_clear_out1 ( opto8_t *ctx );

void opto8_toggle_out1 ( opto8_t *ctx );

void opto8_set_out2 ( opto8_t *ctx );

void opto8_clear_out2 ( opto8_t *ctx );

void opto8_toggle_out2 ( opto8_t *ctx );

uint8_t opto8_get_in1 ( opto8_t *ctx );

uint8_t opto8_get_in2 ( opto8_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // OPTO8_H
 // opto8
 
// ------------------------------------------------------------------------ END